Start SQL Agent Job
Description
This plugin is designed to Start Agent Job to handle other automated tasks. This step only ensures start of SQL agent job and not monitoring the completion of action(s) (successful execution) present in the job. Prerequisites:
- SQL Server instance and access details
- SQL Server Browser service must be enabled on remote machine.
- SQL Server Agent must be enabled.
- sqljdbc4-4.0.jar must be present in lib folder of Process Studio as well as AE agent.
- SQL Server has the following msdb database fixed database roles, which gives administrators
control over access to SQL Server Agent. The roles are: • SQL Agent User Role • SQL Agent Reader Role • SQL Agent Operator Role
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Connection: | ||
| 2 | Server Name | The Hostname/Server Name/IP of the MSSQL Server. This field is mandatory. Drop down is available. |
| 3 | Instance name | The instance name of MSSQL Server instance. One of the two fields Instance name or Port is mandatory. Only variables/static values are allowed. |
| 4 | Port Number | The port number of the MSSQL Server. One of the two fields Instance name or Port is mandatory. Only variables/static values are allowed. |
| 5 | Username | A username of the MSSQL Server. This field is mandatory. |
| Password | ||
| 6 | Checkbox: Accept Value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 7 | Password | Provide the password of the username of MSSQL Server. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. |
| 8 | Other Connection Parameter | Specify multiple, semi-colon separated parameters other than the default connection parameters. Other connection parameters will be appended to the default connection parameters. Example of default connection parameters: Server Name, Password. Examples of other connection parameters: encrypt=false;trustServerCertificate=false |
| Button | ||
| 9 | Test Connection | Verifies whether the connection is established or not. NOTE: Test Connection button does not work for previous step fields. Test Connection button only works with static values and environment variables. |
| Input Fields | ||
| 1 | Job Name | Name of the job to start. |
| 2 | Button: Get | Clicking on this button brings a dialog for the available jobs on that particular SQL server instance.Get Button will work for user having system admin’s permission or having agent roles mentioned below with access on msdb.dbo.sysjobs table. |
| Output Fields: | ||
| 1 | Result | Output field to hold the result of the successful plugin execution |